home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / Composite.z / Composite
Encoding:
Text File  |  2001-04-17  |  11.0 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      CCCCoooommmmppppoooossssiiiitttteeee((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   CCCCoooommmmppppoooossssiiiitttteeee((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           CCCCoooommmmppppoooossssiiiitttteeee - The Composite widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/Xm.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           Composite widgets are intended to be containers for other
  19.           widgets and can have an arbitrary number of children. Their
  20.           responsibilities (implemented either directly by the widget
  21.           class or indirectly by Intrinsics functions) include:
  22.  
  23.              +o  Overall management of children from creation to
  24.                 destruction.
  25.  
  26.              +o  Destruction of descendants when the composite widget
  27.                 is destroyed.
  28.  
  29.              +o  Physical arrangement (geometry management) of a
  30.                 displayable subset of managed children.
  31.  
  32.              +o  Mapping and unmapping of a subset of the managed
  33.                 children.  Instances of composite widgets need to
  34.                 specify the order in which their children are kept.
  35.                 For example, an application may want a set of command
  36.                 buttons in some logical order grouped by function, and
  37.                 it may want buttons that represent filenames to be
  38.                 kept in alphabetical order.
  39.  
  40.         CCCCllllaaaasssssssseeeessss
  41.           Composite inherits behavior and resources from CCCCoooorrrreeee.
  42.  
  43.           The class pointer is _c_o_m_p_o_s_i_t_e_W_i_d_g_e_t_C_l_a_s_s.
  44.  
  45.           The class name is CCCCoooommmmppppoooossssiiiitttteeee.
  46.  
  47.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  48.           The following table defines a set of widget resources used
  49.           by the programmer to specify data. The programmer can also
  50.           set the resource values for the inherited classes to set
  51.           attributes for this widget. To reference a resource by name
  52.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  53.           prefix and use the remaining letters. To specify one of the
  54.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  55.           the XXXXmmmm prefix and use the remaining letters (in either
  56.           lowercase or uppercase, but include any underscores between
  57.           words).  The codes in the access column indicate if the
  58.           given resource can be set at creation time (C), set by using
  59.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      CCCCoooommmmppppoooossssiiiitttteeee((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   CCCCoooommmmppppoooossssiiiitttteeee((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
  71.  
  72.  
  73.  
  74.           not applicable (N/A).
  75.  
  76.                                   CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  77.           NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  78.           XmNchildren         XmCReadOnly         WidgetList    NULL      G
  79.           XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  80.           XmNnumChildren      XmCReadOnly         Cardinal      0         G
  81.  
  82.           XXXXmmmmNNNNcccchhhhiiiillllddddrrrreeeennnn
  83.                     A read-only list of the children of the widget.
  84.  
  85.           XXXXmmmmNNNNiiiinnnnsssseeeerrrrttttPPPPoooossssiiiittttiiiioooonnnn
  86.                     Points to the _X_t_O_r_d_e_r_P_r_o_c function described
  87.                     below.
  88.  
  89.           XXXXmmmmNNNNnnnnuuuummmmCCCChhhhiiiillllddddrrrreeeennnn
  90.                     A read-only resource specifying the length of the
  91.                     list of children in XXXXmmmmNNNNcccchhhhiiiillllddddrrrreeeennnn.
  92.  
  93.           The following procedure pointer in a composite widget
  94.           instance is of type _X_t_O_r_d_e_r_P_r_o_c:
  95.  
  96.           Cardinal (* XtOrderProc) (Widget _w);
  97.  
  98.           _w         Specifies the widget.
  99.  
  100.           Composite widgets that allow clients to order their children
  101.           (usually homogeneous boxes) can call their widget instance's
  102.           XXXXmmmmNNNNiiiinnnnsssseeeerrrrttttPPPPoooossssiiiittttiiiioooonnnnprocedure from the class's iiiinnnnsssseeeerrrrtttt____cccchhhhiiiilllldddd
  103.           procedure to determine where a new child should go in its
  104.           children array. Thus, a client of a composite class can
  105.           apply different sorting criteria to widget instances of the
  106.           class, passing in a different XXXXmmmmNNNNiiiinnnnsssseeeerrrrttttPPPPoooossssiiiittttiiiioooonnnnprocedure
  107.           when it creates each composite widget instance.
  108.  
  109.           The return value of the XXXXmmmmNNNNiiiinnnnsssseeeerrrrttttPPPPoooossssiiiittttiiiioooonnnnprocedure indicates
  110.           how many children should go before the widget. A value of 0
  111.           (zero) indicates that the widget should go before all other
  112.           children; returning the value of _X_m_N_u_m_C_h_i_l_d_r_e_nindicates that
  113.           it should go after all other children.  By default, unless a
  114.           subclass or an application provides an XXXXmmmmNNNNiiiinnnnsssseeeerrrrttttPPPPoooossssiiiittttiiiioooonnnn
  115.           procedure, each child is inserted at the end of the
  116.           XXXXmmmmNNNNcccchhhhiiiillllddddrrrreeeennnn list.  The XXXXmmmmNNNNiiiinnnnsssseeeerrrrttttPPPPoooossssiiiittttiiiioooonnnn procedure can be
  117.           overridden by a specific composite widget's resource list or
  118.           by the argument list provided when the composite widget is
  119.           created.
  120.  
  121.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  122.           Composite inherits behavior and resources from the
  123.           superclass described in the following table.  For a complete
  124.           description of each resource, refer to the reference page
  125.           for that superclass.
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      CCCCoooommmmppppoooossssiiiitttteeee((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   CCCCoooommmmppppoooossssiiiitttteeee((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
  137.  
  138.  
  139.  
  140.                                                         CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  141.           NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  142.           XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  143.           XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  144.           XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  145.           XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  146.           XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  147.           XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  148.           XmNborderWidth                  XmCBorderWidth                  Dimension        1                      CSG
  149.           XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  150.           XmNdepth                        XmCDepth                        int              dynamic                CG
  151.           XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  152.           XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  153.           XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  154.           XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  155.           XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  156.           XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  157.           XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  158.           XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  159.           XmNx                            XmCPosition                     Position         0                      CSG
  160.           XmNy                            XmCPosition                     Position         0                      CSG
  161.  
  162.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  163.           There are no translations for Composite.
  164.  
  165.      RRRREEEELLLLAAAATTTTEEEEDDDD
  166.           CCCCoooorrrreeee(3).
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 4/6/01)
  196.  
  197.  
  198.  
  199.